logo
API docs by Redocly

Address Validation Management (2.14)

Download OpenAPI specification:Download

Address Validation Management Concepts

This Address Validation Management API provides developers a way to vaildate address information and determine its tax jursidiction

Address Validation

Resources for validating address and retreiving log results for previous validations.

Validate Address

Provides the ability to validate an address so that the associated tax jurisdictions can be assigned. [Rev 1.04]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
required
object
failureCount
integer

The number of address validation failure attempts. The system allows for a configurable threshold that will bypass the address validation/correction process once that limit is hit.

  • Note: If no value is submitted, then validation will proceed; Otherwise the system will use the value internally to determine if the validation request should be processed.
lastValidationDate
string <date-time>

The last address validation date associated with the contact.

  • Note: If no value is submitted, then validation will proceed; Otherwise the system will use the value internally to determine if the validation request should be processed.
validationTypeID
required
integer

Unique identifier for the validation type that is requested to be used to validate the address.

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "failureCount": 3,
  • "lastValidationDate": "2019-05-01T18:00:00.000Z",
  • "validationTypeID": 3
}

Response samples

Content type
application/json
{
  • "actualValidationType": "Basic",
  • "addressStandardized": [
    ],
  • "attemptedValidationType": "Basic",
  • "errorCode": "Basic_B01_NoMatchingAddressRecordsFound",
  • "excludeReasonID": "",
  • "failureCount": "",
  • "isPOBox": true,
  • "isSkipped": false,
  • "isValidated": true,
  • "rawResultCode": "A0000",
  • "requestedValidationType": "Basic",
  • "validationDate": "2019-05-01T18:00:00.000Z",
  • "addressValidationLogID": 1
}

Search Validation Logs

Used to search validation logs for your environment. [Rev 1.04]

Available Fields

The following is a list of fields and how they can be used within the search.

  • Filterable: validationLogID, actualValidationTypeID,attemptedValidationTypeID, entryDate, requestedValidationTypeID, userID, testMode, isSkipped
  • Sortable: validationLogID, actualValidationTypeID,attemptedValidationTypeID, entryDate, requestedValidationTypeID, userID, testMode, isSkipped
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=Name eq 'AuthorizationProvider1'

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=Name

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. If no $orderby is specified, the default sort order is descending by UserID.

$select
string
Example: $select=AuthorizationURI

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$skiptoken
number
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
number
Example: $top=1

Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "actualValidationType": "USPS",
  • "actualValidationTypeID": 2,
  • "attemptedValidationType": "USPS",
  • "attemptedValidationTypeID": 2,
  • "censusBlockCode": 123,
  • "censusCounty": "MNR",
  • "censusState": "NY",
  • "censusTract": 11130,
  • "cityRequest": "Rochester",
  • "cityResponse": "ROCHESTER",
  • "countryRequest": "USA",
  • "countryResponse": "USA",
  • "countyRequest": "Monroe",
  • "countyResponse": "MONROE",
  • "entryDate": "1901-01-01T05:00:00.000Z",
  • "environment": "JESP",
  • "fipsCode": 12344556,
  • "isSkipped": false,
  • "latitude": "1234.00,",
  • "longitude": 1234,
  • "requestedValidationTypeID": 3,
  • "requestedValidationType": "Basic",
  • "stateRequest": "ny",
  • "stateResponse": "NY",
  • "street1Request": "1234 main avenue",
  • "street2Request": "example",
  • "street3Request": "example 3",
  • "street1Response": "1600 EAST AVE",
  • "street2Response": "apartment",
  • "street3Response": "123",
  • "testMode": false,
  • "userID": "ws_user",
  • "validationLogID": 1,
  • "zipCodeRequest": 14610,
  • "zipCodeResponse": "146101673"
}

Search Validation Type

Used to view the available validation types.

Available Fields

The following is a list of fields and how they can be used within the search.

  • Filterable: validationTypeID
  • Sortable: description, validationTypeID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=Name eq 'AuthorizationProvider1'

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=Name

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. If no $orderby is specified, the default sort order is descending by UserID.

$select
string
Example: $select=AuthorizationURI

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$skiptoken
number
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
number
Example: $top=1

Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "validationTypeID": 2,
  • "description": "USPS"
}

View Validation Log Summary

Used to view the validation log summary for your environment.

Authorizations:
SWT
query Parameters
fromDate
string <date-time>
Example:

Tthe starting date and time from which the validation log summary result swill be filtered to.

toDate
string <date-time>
Example:

The ending date and time from which the validation log summary results will be filtered to.

validationTypeID
integer
Example:

The specific validation type ID that the validation log summary results will be filtered to.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "censusBlockCode": 123,
  • "censusCounty": "MNR",
  • "censusState": "NY",
  • "censusTract": 11130,
  • "validationType": "USPS",
  • "validationTypeID": 2,
  • "totalAttemptedValidations": 133,
  • "totalValidations": 123,
  • "totalErrors": 10
}

Special District Codes

Used to view the special district codes associated with a previously logged address validation response.

Authorizations:
SWT
path Parameters
validationLogID
required
integer
Example: 1

Id of ValidationLog to search against.

Responses

Response samples

Content type
application/json
{
  • "specialDistrictCodes": [
    ]
}

System Integrity

This Address Validation Management API provides developers a way to vaildate address information and determine the its tax jursidiction.

Health Check

Use to check whether or not the AddressValidationManagement service is up and running.

Authorizations:
SWT

Responses

USPS Info

Use to check the version and expiration date of the USPS libraries.

Authorizations:
SWT

Responses

Response samples

Content type
application/json
{
  • "dataExpireDays": "110",
  • "codeExpireDays": "355",
  • "isInitialized": "True",
  • "z4Date": "20220815",
  • "z4Version": "3.17.07.N"
}

Release Notes

Release Notes 2.14

Release Notes 2.13

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.12

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.11

Release Notes 2.10

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.09

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.08

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.07

Release Notes 2.06

  • Added GET /api/getUSPSInfo operation to retrieve information regarding expiration date of USPS files.

Release Notes 2.05

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.04

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.03

Release Notes 2.02

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.01

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.00

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.07

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.06

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.05

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.04

Release Notes 1.03

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.02

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.01